<!DOCTYPE HTML>

<html lang="en">
<head>

<title>Saml2AuthenticationRequestFactory (spring-security-docs 5.6.3 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../../../jquery/jquery-3.5.1.js"></script>
<script type="text/javascript" src="../../../../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
    try {
        if (location.href.indexOf('is-external=true') == -1) {
            parent.document.title="Saml2AuthenticationRequestFactory (spring-security-docs 5.6.3 API)";
        }
    }
    catch(err) {
    }
//-->
var data = {"i0":38,"i1":18,"i2":18};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default Methods"],32:["t6","Deprecated Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">

<div class="topNav"><a id="navbar.top">

</a>
<div class="skipNav"><a href="Saml2AuthenticationRequestFactory.html#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">

</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_top");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="Saml2AuthenticationRequestFactory.html#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="Saml2AuthenticationRequestFactory.html#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">

</a></div>

</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>

<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.springframework.security.saml2.provider.service.authentication</a></div>
<h2 title="Interface Saml2AuthenticationRequestFactory" class="title">Interface Saml2AuthenticationRequestFactory</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<pre>public interface <span class="typeNameLabel">Saml2AuthenticationRequestFactory</span></pre>
<div class="block">Component that generates AuthenticationRequest, <code>samlp:AuthnRequestType</code>
XML, and accompanying signature data. as defined by
https://www.oasis-open.org/committees/download.php/35711/sstc-saml-core-errata-2.0-wd-06-diff.pdf
Page 50, Line 2147</div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>5.2</dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">

<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">

</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="Saml2AuthenticationRequestFactory.html#createAuthenticationRequest(org.springframework.security.saml2.provider.service.authentication.Saml2AuthenticationRequest)">createAuthenticationRequest</a></span>&#8203;(<a href="Saml2AuthenticationRequest.html" title="class in org.springframework.security.saml2.provider.service.authentication">Saml2AuthenticationRequest</a>&nbsp;request)</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">please use
<a href="Saml2AuthenticationRequestFactory.html#createRedirectAuthenticationRequest(org.springframework.security.saml2.provider.service.authentication.Saml2AuthenticationRequestContext)"><code>createRedirectAuthenticationRequest(Saml2AuthenticationRequestContext)</code></a> or
<a href="Saml2AuthenticationRequestFactory.html#createPostAuthenticationRequest(org.springframework.security.saml2.provider.service.authentication.Saml2AuthenticationRequestContext)"><code>createPostAuthenticationRequest(Saml2AuthenticationRequestContext)</code></a> This
method will be removed in future versions of Spring Security</div>
</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>default <a href="Saml2PostAuthenticationRequest.html" title="class in org.springframework.security.saml2.provider.service.authentication">Saml2PostAuthenticationRequest</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="Saml2AuthenticationRequestFactory.html#createPostAuthenticationRequest(org.springframework.security.saml2.provider.service.authentication.Saml2AuthenticationRequestContext)">createPostAuthenticationRequest</a></span>&#8203;(<a href="Saml2AuthenticationRequestContext.html" title="class in org.springframework.security.saml2.provider.service.authentication">Saml2AuthenticationRequestContext</a>&nbsp;context)</code></th>
<td class="colLast">
<div class="block">Creates all the necessary AuthNRequest parameters for a POST binding.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>default <a href="Saml2RedirectAuthenticationRequest.html" title="class in org.springframework.security.saml2.provider.service.authentication">Saml2RedirectAuthenticationRequest</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="Saml2AuthenticationRequestFactory.html#createRedirectAuthenticationRequest(org.springframework.security.saml2.provider.service.authentication.Saml2AuthenticationRequestContext)">createRedirectAuthenticationRequest</a></span>&#8203;(<a href="Saml2AuthenticationRequestContext.html" title="class in org.springframework.security.saml2.provider.service.authentication">Saml2AuthenticationRequestContext</a>&nbsp;context)</code></th>
<td class="colLast">
<div class="block">Creates all the necessary AuthNRequest parameters for a REDIRECT binding.</div>
</td>
</tr>
</table>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">

<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">

</a>
<h3>Method Detail</h3>
<a id="createAuthenticationRequest(org.springframework.security.saml2.provider.service.authentication.Saml2AuthenticationRequest)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>createAuthenticationRequest</h4>
<pre class="methodSignature">@Deprecated
java.lang.String&nbsp;createAuthenticationRequest&#8203;(<a href="Saml2AuthenticationRequest.html" title="class in org.springframework.security.saml2.provider.service.authentication">Saml2AuthenticationRequest</a>&nbsp;request)</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">please use
<a href="Saml2AuthenticationRequestFactory.html#createRedirectAuthenticationRequest(org.springframework.security.saml2.provider.service.authentication.Saml2AuthenticationRequestContext)"><code>createRedirectAuthenticationRequest(Saml2AuthenticationRequestContext)</code></a> or
<a href="Saml2AuthenticationRequestFactory.html#createPostAuthenticationRequest(org.springframework.security.saml2.provider.service.authentication.Saml2AuthenticationRequestContext)"><code>createPostAuthenticationRequest(Saml2AuthenticationRequestContext)</code></a> This
method will be removed in future versions of Spring Security</div>
</div>
<div class="block">Creates an authentication request from the Service Provider, sp, to the Identity
Provider, idp. The authentication result is an XML string that may be signed,
encrypted, both or neither. This method only returns the <code>SAMLRequest</code> string
for the request, and for a complete set of data parameters please use
<a href="Saml2AuthenticationRequestFactory.html#createRedirectAuthenticationRequest(org.springframework.security.saml2.provider.service.authentication.Saml2AuthenticationRequestContext)"><code>createRedirectAuthenticationRequest(Saml2AuthenticationRequestContext)</code></a> or
<a href="Saml2AuthenticationRequestFactory.html#createPostAuthenticationRequest(org.springframework.security.saml2.provider.service.authentication.Saml2AuthenticationRequestContext)"><code>createPostAuthenticationRequest(Saml2AuthenticationRequestContext)</code></a></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>request</code> - information about the identity provider, the recipient of this
authentication request and accompanying data</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>XML data in the format of a String. This data may be signed, encrypted,
both signed and encrypted with the signature embedded in the XML or neither signed
and encrypted</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../Saml2Exception.html" title="class in org.springframework.security.saml2">Saml2Exception</a></code> - when a SAML library exception occurs</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>5.2</dd>
</dl>
</li>
</ul>
<a id="createRedirectAuthenticationRequest(org.springframework.security.saml2.provider.service.authentication.Saml2AuthenticationRequestContext)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>createRedirectAuthenticationRequest</h4>
<pre class="methodSignature">default&nbsp;<a href="Saml2RedirectAuthenticationRequest.html" title="class in org.springframework.security.saml2.provider.service.authentication">Saml2RedirectAuthenticationRequest</a>&nbsp;createRedirectAuthenticationRequest&#8203;(<a href="Saml2AuthenticationRequestContext.html" title="class in org.springframework.security.saml2.provider.service.authentication">Saml2AuthenticationRequestContext</a>&nbsp;context)</pre>
<div class="block">Creates all the necessary AuthNRequest parameters for a REDIRECT binding. If the
<a href="Saml2AuthenticationRequestContext.html" title="class in org.springframework.security.saml2.provider.service.authentication"><code>Saml2AuthenticationRequestContext</code></a> doesn't contain any
<a href="../../../core/Saml2X509Credential.Saml2X509CredentialType.html#SIGNING"><code>Saml2X509Credential.Saml2X509CredentialType.SIGNING</code></a> credentials the result will not contain any
signatures. The data set will be signed and encoded for REDIRECT binding including
the DEFLATE encoding. It will contain the following parameters to be sent as part
of the query string: <code>SAMLRequest, RelayState, SigAlg, Signature</code>. <i>The
default implementation, for sake of backwards compatibility, of this method returns
the SAMLRequest message with an XML signature embedded, that should only be used
for the<a href="../registration/Saml2MessageBinding.html#POST"><code>Saml2MessageBinding.POST</code></a> binding, but works over
<a href="../registration/Saml2MessageBinding.html#POST"><code>Saml2MessageBinding.POST</code></a> with most providers.</i></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>context</code> - - information about the identity provider, the recipient of this
authentication request and accompanying data</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <a href="Saml2RedirectAuthenticationRequest.html" title="class in org.springframework.security.saml2.provider.service.authentication"><code>Saml2RedirectAuthenticationRequest</code></a> object with applicable http
parameters necessary to make the AuthNRequest over a POST or REDIRECT binding. All
parameters will be SAML encoded/deflated, but escaped, ie URI encoded or encoded
for Form Data.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../Saml2Exception.html" title="class in org.springframework.security.saml2">Saml2Exception</a></code> - when a SAML library exception occurs</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>5.3</dd>
</dl>
</li>
</ul>
<a id="createPostAuthenticationRequest(org.springframework.security.saml2.provider.service.authentication.Saml2AuthenticationRequestContext)">

</a>
<ul class="blockListLast">
<li class="blockList">
<h4>createPostAuthenticationRequest</h4>
<pre class="methodSignature">default&nbsp;<a href="Saml2PostAuthenticationRequest.html" title="class in org.springframework.security.saml2.provider.service.authentication">Saml2PostAuthenticationRequest</a>&nbsp;createPostAuthenticationRequest&#8203;(<a href="Saml2AuthenticationRequestContext.html" title="class in org.springframework.security.saml2.provider.service.authentication">Saml2AuthenticationRequestContext</a>&nbsp;context)</pre>
<div class="block">Creates all the necessary AuthNRequest parameters for a POST binding. If the
<a href="Saml2AuthenticationRequestContext.html" title="class in org.springframework.security.saml2.provider.service.authentication"><code>Saml2AuthenticationRequestContext</code></a> doesn't contain any
<a href="../../../core/Saml2X509Credential.Saml2X509CredentialType.html#SIGNING"><code>Saml2X509Credential.Saml2X509CredentialType.SIGNING</code></a> credentials the result will not contain any
signatures. The data set will be signed and encoded for POST binding and if
applicable signed with XML signatures. will contain the following parameters to be
sent as part of the form data: <code>SAMLRequest, RelayState</code>. <i>The default
implementation of this method returns the SAMLRequest message with an XML signature
embedded, that should only be used for the <a href="../registration/Saml2MessageBinding.html#POST"><code>Saml2MessageBinding.POST</code></a>
binding.</i></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>context</code> - - information about the identity provider, the recipient of this
authentication request and accompanying data</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a <a href="Saml2PostAuthenticationRequest.html" title="class in org.springframework.security.saml2.provider.service.authentication"><code>Saml2PostAuthenticationRequest</code></a> object with applicable http
parameters necessary to make the AuthNRequest over a POST binding. All parameters
will be SAML encoded but not escaped for Form Data.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../Saml2Exception.html" title="class in org.springframework.security.saml2">Saml2Exception</a></code> - when a SAML library exception occurs</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>5.3</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>

<footer role="contentinfo">
<nav role="navigation">

<div class="bottomNav"><a id="navbar.bottom">

</a>
<div class="skipNav"><a href="Saml2AuthenticationRequestFactory.html#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">

</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_bottom");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="Saml2AuthenticationRequestFactory.html#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="Saml2AuthenticationRequestFactory.html#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">

</a></div>

</nav>
</footer>
<script>if (window.parent == window) {(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)})(window,document,'script','//www.google-analytics.com/analytics.js','ga');ga('create', 'UA-2728886-23', 'auto', {'siteSpeedSampleRate': 100});ga('send', 'pageview');}</script><script defer src="https://static.cloudflareinsights.com/beacon.min.js/v652eace1692a40cfa3763df669d7439c1639079717194" integrity="sha512-Gi7xpJR8tSkrpF7aordPZQlW2DLtzUlZcumS8dMQjwDHEnw9I7ZLyiOj/6tZStRBGtGgN6ceN6cMH8z7etPGlw==" data-cf-beacon='{"rayId":"7040f5592e5797cf","token":"bffcb8a918ae4755926f76178bfbd26b","version":"2021.12.0","si":100}' crossorigin="anonymous"></script>
</body>
</html>
